Compliance checker#19
Merged
Merged
Conversation
Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Contributor
There was a problem hiding this comment.
Pull request overview
This pull request introduces automated skill design compliance validation to ensure all skills adhere to the design principles defined in the newly created SKILL_DESIGN_PRINCIPLES.md file. The validation runs automatically in CI for changed skills and provides local development commands for validating all or changed skills.
Changes:
- Extracted design principles from
CLAUDE.mdinto a dedicatedSKILL_DESIGN_PRINCIPLES.mdfile - Added Python validation script and shell script for CI integration to automate compliance checking
- Updated all references across documentation and templates to point to the new design principles file
Reviewed changes
Copilot reviewed 11 out of 11 changed files in this pull request and generated 5 comments.
Show a summary per file
| File | Description |
|---|---|
scripts/validate_skill_design.py |
New Python script implementing automated checks for all 7 design principles |
scripts/ci-validate-changed-skills.sh |
Shell script to validate only changed skills in CI and local development |
SKILL_DESIGN_PRINCIPLES.md |
New file containing extracted design principles from CLAUDE.md |
README.md |
Added documentation for new validation commands and design principles |
Makefile |
Added validate-skill-design and validate-skill-design-changed targets |
CLAUDE.md |
Removed design principles content, replaced with reference to new file |
.github/workflows/validate-packs.yml |
Renamed job, added skill design validation step with git history fetch |
rh-virt/SKILL_TEMPLATE.md |
Updated references from CLAUDE.md to SKILL_DESIGN_PRINCIPLES.md |
.github/copilot-instructions.md |
Updated design principles reference |
.cursor/skills |
Added symlink to .claude/skills directory |
.claude/skills/compliance-checker/SKILL.md |
New skill for running compliance validation |
- Updated CLAUDE.md to clarify YAML frontmatter requirements, including optional metadata fields. - Revised README.md by removing legacy model field skip instructions. - Expanded SKILL_DESIGN_PRINCIPLES.md with details on root-level frontmatter and standard color values. - Modified compliance-checker SKILL.md to improve clarity in usage instructions and workflow. - Updated copilot-instructions.md to reflect new frontmatter requirements. - Adjusted SKILL_TEMPLATE.md to include new metadata fields and color options. - Enhanced validate_skill_design.py to enforce new frontmatter rules and remove legacy model handling. Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Daniele Martinoli <dmartino@redhat.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This pull request introduces a comprehensive skill design compliance validation workflow for the repository, ensuring that all skills adhere to defined design principles. It adds new Makefile targets, CI integration, and documentation to automate and clarify the validation process for both local development and continuous integration. The changes also update references across documentation and templates to point to the new source of design principles.
Skill Design Compliance Validation:
.claude/skills/compliance-checker/SKILL.mddocumenting the compliance checker skill, detailing when and how to use it, dependencies, and the design principles it checks.scripts/ci-validate-changed-skills.shscript to validate only changed skills in CI or local development, improving efficiency and developer experience.Makefilewithvalidate-skill-designandvalidate-skill-design-changedtargets for full and incremental validation, respectively, including help text and integration with the new script.Continuous Integration Improvements:
compliance-check.yml, added a job to run skill design validation only on changed skills, and ensured the workflow fetches the full git history for accurate diffing.Documentation and Reference Updates:
README.mdto document the new validation commands, when to use them, and which design principles are enforced.CLAUDE.mdtoSKILL_DESIGN_PRINCIPLES.mdin documentation, skill templates, and instructions to ensure consistency and clarity.Miscellaneous:
.cursor/skillsentry to track the new skills directory.These changes collectively ensure that skill design compliance is automated, well-documented, and integrated into both developer workflows and CI, raising the quality and consistency of skills in the repository.
Pack(s) affected
rh-srerh-developerocp-adminrh-support-engineerrh-virtChange type
.mcp.json)CLAUDE.md compliance
${VAR}referencesValidation
make validatepasses locallyname,description)name,description)